Authentication

Apart from the web interface, edexa.com's blockchain stamping functionality is also possible through an API interaction. In order to get access to our API please create an account.

info

SANDBOX

https://universe.io-world.com/apis

LIVE

https://universe.edexa.com/apis

---

note

• The Sandbox and Live are the link of edeXa ecosystem from where you can get your secret key and client id 🔑.
• The Sandbox and Live also provides you the feature to check the api working and their response from web.

---

tip

MAINNET BASEURL

  https://api-edexagw.edexa.com/bstamp/

TESTNET BASEURL

  https://api-edexagw.io-world.com/bstamp/ 

---

Authenticate User

POST authenticate

• The following endpoint is used in order to authenticate with our service. For security reasons, the registered user will receive a client id and secret key which will be used in order to authenticate.
• If you are alraedy registered you can get your api credentials : https://accounts.io-world.com

POST: Autheticate User

cURL

curl --location --request POST 'https://api-edexagw.io-world.com/bstamp/authenticate' \
--header 'client-id: <CLIENT ID>' \
--header 'secret-key: <SECRET KEY>'

• client-id is required.
• secret-key is required.
• The Authorization token will be valid for 7 days.

Parameters

Key	Value	Type	Description
clientId*	67809********************8	String	Your client id
secretKey*	789zbh**************8	String	Your secret id

Responses

200: Success

{
  "status": 200,
  "message": "Logged in successfully",
  "data": {
      "token": "eyJhbG***********.eyJzdWIiOiJVMkZzZE***********************",
      "_id": "6135*************",
      "name": "John Doe",
      "username": "John",
      "email": "j*****@gmail.com",
      "status": 1,
      "profilePicture": "",
      "loginType": "social",
      "refreshToken": "eyJhbG***********.eyJzdWIiOiJVMkZzZE*****************",
      "viewType": 0,
      "watermark": 0,
      "align": "top"
  }
}

404: The user is not part of edeXa universe

{
  "status": 404,
  "message": "User Not Found"
}

500: Some Technical Issue Occured

{
  "status": 500,
  "message": "Something went wrong, please try again"
}

---

Get User Profile

GET user-profile

• You have to pass your Bearer Token via the Authorization parameter through the headers.

GET: User Profile

cURL

curl --location --request GET 'https://api-edexagw.io-world.com/bstamp/user-profile' \
--header 'Authorization: Bearer token'

Responses

200: Success

{
 "status": 200,
  "message": "Get details successfully",
  "data": {
      "first_name": "e",
      "last_name": "Jhon",
      "username": "Doe",
      "email": "j**@gmail.com",
      "profilePic": "Profile image",
      "thumbProfile": "Thumb Profile image",
      "_id": "630************",
      "userId": "3e03130f*******************",
      "gender": "Male",
      "status": 1,
      "loginType": "normal",
      "updatedAt": "2022-04-27T12:15:31.283Z",
      "isEmailVerified": 1,
      "dob": "2010-12-31T18:30:00.000Z",
      "kycApproved": 0,
      "twoAuth": false,
      "viewType": 0,
      "watermark": 0,
      "align": "top",
      "language": "EN"
    }
}

401: Token passed in headers is not valid

{
  "status": 401,
  "message": "Invalid auth token"
}

500: Some technical issue occured

{
  "status": 500,
  "message": "Something went wrong, please try again"
}

---

Update User Prefrence

PUT account-preference

• You have to pass your Bearer Token via the Authorization parameter through the headers.

PUT: Account prefrence

cURL

curl --location --request PUT 'https://api-edexagw.io-world.com/bstamp/account-preference' \
--header 'Authorization: Bearer token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'viewType=1' \
--data-urlencode 'watermark=0'

Parameters

Key	Value	Type	Description
watermark	1	Number	0 or 1 (0 to turn off watermark and 1 for adding watermark)
viewType	0	Number	0: for pdf, 1: for json & 2: for none

Responses

200: Success

{
  "status": 200,
  "message": "User preference updated successfully"
}

401: Token passed in headers is not valid

{
  "status": 401,
  "message": "Invalid auth token"
}

500: Some technical issue occured

{
  "status": 500,
  "message": "Something went wrong, please try again"
}